hallcurrent5.h File Reference

This file contains API for Hall Current 5 Click driver. More...

#include "drv_digital_in.h"
#include "drv_analog_in.h"

Go to the source code of this file.

Data Structures
struct	hallcurrent5_t
	Click ctx object definition. More...
struct	hallcurrent5_cfg_t
	Click configuration structure definition. More...

Macros
#define	HALLCURRENT5_MAP_MIKROBUS(cfg, mikrobus)
#define	HALLCURRENT5_RETVAL   uint8_t
#define	HALLCURRENT5_OK   0x00
#define	HALLCURRENT5_INIT_ERROR   0xFF

Typedefs
typedef uint16_t	hallcurrent5_data_t
	Analog data type.

Functions
void	hallcurrent5_cfg_setup (hallcurrent5_cfg_t *cfg)
	Config Object Initialization function.
HALLCURRENT5_RETVAL	hallcurrent5_init (hallcurrent5_t *ctx, hallcurrent5_cfg_t *cfg)
	Initialization function.
hallcurrent5_data_t	hallcurrent5_generic_read (hallcurrent5_t *ctx)
	Generic read function.
float	hallcurrent5_generic_read_voltage (hallcurrent5_t *ctx)
	Generic function for read voltage.
float	hallcurrent5_get_current (hallcurrent5_t *ctx)
	Get ADC current value function.
uint8_t	hallcurrent5_get_fault (hallcurrent5_t *ctx)
	Get ADC fault function.
void	hallcurrent5_set_init_voltage (hallcurrent5_t *ctx, uint16_t voltage)
	Get ADC current value function.

Detailed Description

This file contains API for Hall Current 5 Click driver.